OPC Studio User's Guide and Reference
Remove Method (IKeyedCollection<TKey,TItem>)



OpcLabs.BaseLib Assembly > OpcLabs.BaseLib.Collections.Generic Namespace > IKeyedCollection<TKey,TItem> Interface : Remove Method
The key of the element to remove.

The value of this parameter cannot be null (Nothing in Visual Basic).

Removes the element with the specified key from the IKeyedCollection<TKey,TItem>.
Syntax
'Declaration
 
Function Remove( _
   ByVal key As TKey _
) As Boolean
'Usage
 
Dim instance As IKeyedCollection(Of TKey,TItem)
Dim key As TKey
Dim value As Boolean
 
value = instance.Remove(key)
bool Remove( 
   TKey key
)
bool Remove( 
   TKey^ key
) 

Parameters

key
The key of the element to remove.

The value of this parameter cannot be null (Nothing in Visual Basic).

Return Value

true if the element is successfully removed; otherwise, false. This method also returns false if key is not found in the IKeyedCollection<TKey,TItem>.
Exceptions
ExceptionDescription

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

See Also